/*
 * Copyright (c) 2009-2010, Dennis Wang (dennis.wangkk@gmail.com)
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the University of California, Berkeley nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 \file auto_proxy_table.hpp
 */

#ifndef auto_proxy_table_hpp
#define auto_proxy_table_hpp

#include <map>
#include <cassert>
#include "proxy_manager.hpp"
#include "proxy.hpp"

/*!
 \brief create proxy as demand and cleanup all proxies automatically
 */

class AutoProxyTable
{
public:

    /*!
     \brief constructor
     \param proxyManager_ ProxyManager pointer
     */

    AutoProxyTable (ProxyManager* proxyManager_)
        : _proxyManager (proxyManager_) {
        assert (proxyManager_);
    }

    /*!
     \brief destructor

            cleanup all proxies
     */

    ~AutoProxyTable ();

    /*!
     \brief test whether already forked proxy as given id_
     \param id_ instance identifier
     \retval true
     \retval false
     */

    bool has (int id_);

    /*!
     \brief get proxy by given id_
     \param id_ instance identifier
     \retval Proxy pointer
     */

    Proxy* operator[] (int id_);

    /*!
     \brief destroy proxy by given id_
     \param id_ instance ID
     */

    int destroyProxy (int id_);

    /*!
     \brief destroy proxy by plugin name
     \param pluginName_ plugin name
     */

    int destroyProxy (const std::string& pluginName_);

private:
    AutoProxyTable (AutoProxyTable&);
    AutoProxyTable& operator= (const AutoProxyTable&);

private:
    typedef std::map<int, Proxy*> ProxyTable;

    ProxyManager* _proxyManager; ///< Proxy Manager pointer
    ProxyTable    _proxyTable;   ///< proxy table
};

#endif // auto_proxy_table_hpp
